/* Copyright 2010, Object Management Group, Inc.
 * Copyright 2010, PrismTech, Inc.
 * Copyright 2010, Real-Time Innovations, Inc.
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.omg.dds.sub;

import java.util.Set;

import org.omg.dds.core.Bootstrap;


public enum InstanceState {
    // -----------------------------------------------------------------------
    // States
    // -----------------------------------------------------------------------

    ALIVE(0x0001 << 0),
    NOT_ALIVE_DISPOSED(0x0001 << 1),
    NOT_ALIVE_NO_WRITERS(0x0001 << 2);



    // -----------------------------------------------------------------------
    // Constants
    // -----------------------------------------------------------------------

    public final int value;



    // -----------------------------------------------------------------------
    // Object Life Cycle
    // -----------------------------------------------------------------------

    /**
     * @param bootstrap Identifies the Service instance to which the
     *                  object will belong.
     */
    public static Set<InstanceState> anyInstanceStateSet(
            Bootstrap bootstrap) {
        return bootstrap.getSPI().anyInstanceStateSet();
    }


    /**
     * @param bootstrap Identifies the Service instance to which the
     *                  object will belong.
     */
    public static Set<InstanceState> notAliveInstanceStateSet(
            Bootstrap bootstrap) {
        return bootstrap.getSPI().anyInstanceStateSet();
    }


    // -----------------------------------------------------------------------

    private InstanceState(int value) {
        this.value = value;
    }

}
